org.eclipse.vtp.framework.spi
Interface ISession

All Known Implementing Classes:

Session

public interface ISession

A collection of executions of the steps in a process.

Author:

Lonnie Pryor

Method Summary

IExecution	createExecution(IExecutionDescriptor descriptor) Creates a new process execution context at the current location.
IProcess	getProcess() Returns the process that created this session.
java.lang.String	getSessionID() Returns the ID of the session being described.
java.lang.Object[]	lookupAllServices(java.lang.String identifier) Returns an array containing all the services registered under the specified identifier.
java.lang.Object	lookupService(java.lang.String identifier) Looks up the service selected for the specified identifier or null if no such service exists.

Method Detail

getSessionID

java.lang.String getSessionID()

Returns the ID of the session being described.

Returns:

The ID of the session being described.

lookupService

java.lang.Object lookupService(java.lang.String identifier)
                               throws java.lang.NullPointerException

Looks up the service selected for the specified identifier or null if no such service exists.

Parameters:

identifier - The identifier of the service to look up.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

lookupAllServices

java.lang.Object[] lookupAllServices(java.lang.String identifier)
                                     throws java.lang.NullPointerException

Returns an array containing all the services registered under the specified identifier.

Parameters:

identifier - The identifier of the services to look up.

Returns:

An array containing all the services registered under the specified identifier.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

createExecution

IExecution createExecution(IExecutionDescriptor descriptor)
                           throws java.lang.NullPointerException

Creates a new process execution context at the current location.

Parameters:

descriptor - The descriptor of the execution to create.

Returns:

A new process engine session from the specified descriptor.

Throws:

java.lang.NullPointerException - If the specified descriptor is null.

getProcess

IProcess getProcess()

Returns the process that created this session.

Returns:

The process that created this session.